com.inscoper.api.Utils¶

Utils class provides utility functions. More...

Public Functions¶

	Name
synchronized void	delete()
	Utils()
String	deviceTypeToString(EDeviceType deviceType) Convert EDeviceType enum to string.
com.inscoper.nbo.ENBOType	deviceTypeToNBOType(EDeviceType deviceType) Convert EDeviceType to ENBOType.
EDeviceType	stringToDeviceType(String deviceTypeStr) Convert string to EDeviceType.
String	driverTypeToString(EDriverType driverType) Convert EDriverType enum to string.
EDriverType	stringToDriverType(String driverTypeStr) Convert string to EDriverType.
String	functionTypeToString(EFunctionType functionType) Convert EFunctionType enum to string.
EFunctionType	stringToFunctionType(String functionTypeStr) Convert string to EFunctionType.
String	paramTypeToString(EParamType paramType) Convert EParamType enum to string.
EParamType	stringToParamType(String paramTypeStr) Convert string to EParamType.
String	subDeviceLabelToString(ESubDeviceLabel label) convert a ESubDevicLabel enum to string
ESubDeviceLabel	stringToSubDeviceLabel(String labelStr) convert a string to ESubDeviceLabel
String	subDeviceStatusToString(ESubDeviceStatus status) Convert ESubDeviceStatus enum to string.
ESubDeviceStatus	stringToSubDeviceStatus(String statusStr) Convert string to ESubDeviceStatus.
String	functionStatusToString(EFunctionStatus status) Convert EFunctionStatus enum to string.
EFunctionStatus	stringToFunctionStatus(String statusStr) Convert string to EFunctionStatus.
String	connectionTypeDescToString(EConnectionTypeDesc connectionTypeDesc) Convert EConnectionTypeDesc enum to string.
EConnectionTypeDesc	stringToConnectionTypeDesc(String connectionTypeDescStr) Convert string to EConnectionTypeDesc.
String	logLevelToString(ELogLevel logLevel) Convert ELogLevel enum to string.
ELogLevel	stringToLogLevel(String logLevelStr) Convert string to ELogLevel.
String	dataToString(UCharVector data) Convert data bytes to string.
int	dataToInt(UCharVector data) Convert data bytes to integer.
double	dataToDouble(UCharVector data) Convert data bytes to double.
String	boxTypeToString(EBoxType type) Convert EBoxType enum to string.
EBoxType	stringToBoxType(String boxTypeStr) Convert string to EBoxType.
String	stripAsTag(String str) Strip string to only keep alphanumeric characters for use as a tag.

Protected Functions¶

	Name
	Utils(long cPtr, boolean cMemoryOwn)
void	finalize()
long	getCPtr(Utils obj)
long	swigRelease(Utils obj)

Protected Attributes¶

	Name
transient boolean	swigCMemOwn

Detailed Description¶

public class com.inscoper.api.Utils;

Utils class provides utility functions.

This class contains helper functions for converting between enum types and their string representations, as well as data conversion utilities.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function Utils¶

public Utils()

function deviceTypeToString¶

public static String deviceTypeToString(
    EDeviceType deviceType
)

Convert EDeviceType enum to string.

Parameters:

deviceType : The device type to convert

Return: The corresponding string value. "" if unknown device type

function deviceTypeToNBOType¶

public static com.inscoper.nbo.ENBOType deviceTypeToNBOType(
    EDeviceType deviceType
)

Convert EDeviceType to ENBOType.

Parameters:

deviceType : The device type to convert

Return: The corresponding NBO type. UNKNOWN if unknown device type

function stringToDeviceType¶

public static EDeviceType stringToDeviceType(
    String deviceTypeStr
)

Convert string to EDeviceType.

Parameters:

deviceTypeStr : The device type string to convert

Return: The corresponding type. GENERIC if unknown device type

function driverTypeToString¶

public static String driverTypeToString(
    EDriverType driverType
)

Convert EDriverType enum to string.

Parameters:

driverType : The driver type to convert

Return: The corresponding string value. "" if unknown driver type

function stringToDriverType¶

public static EDriverType stringToDriverType(
    String driverTypeStr
)

Convert string to EDriverType.

Parameters:

driverTypeStr : The driver type string to convert

Return: The corresponding type. INSCOPER_BOX if unknown driver type

function functionTypeToString¶

public static String functionTypeToString(
    EFunctionType functionType
)

Convert EFunctionType enum to string.

Parameters:

functionType : The function type to convert

Return: The corresponding string value. "" if unknown function type

function stringToFunctionType¶

public static EFunctionType stringToFunctionType(
    String functionTypeStr
)

Convert string to EFunctionType.

Parameters:

functionTypeStr : The function type string to convert

Return: The corresponding type. SET if unknown function type

function paramTypeToString¶

public static String paramTypeToString(
    EParamType paramType
)

Convert EParamType enum to string.

Parameters:

paramType : The parameter type to convert

Return: The corresponding string value. "" if unknown parameter type

function stringToParamType¶

public static EParamType stringToParamType(
    String paramTypeStr
)

Convert string to EParamType.

Parameters:

paramTypeStr : The parameter type string to convert

Return: The corresponding type. UINT8 if unknown parameter type

function subDeviceLabelToString¶

public static String subDeviceLabelToString(
    ESubDeviceLabel label
)

convert a ESubDevicLabel enum to string

Return: The corresponding string value. "" if unknown sub-device type

function stringToSubDeviceLabel¶

public static ESubDeviceLabel stringToSubDeviceLabel(
    String labelStr
)

convert a string to ESubDeviceLabel

Parameters:

labelStr : the string to convert

Return: the corresponding enum

function subDeviceStatusToString¶

public static String subDeviceStatusToString(
    ESubDeviceStatus status
)

Convert ESubDeviceStatus enum to string.

Parameters:

status : The sub-device status to convert

Return: The corresponding string value. "UNKNOWN" if unknown sub-device status

function stringToSubDeviceStatus¶

public static ESubDeviceStatus stringToSubDeviceStatus(
    String statusStr
)

Convert string to ESubDeviceStatus.

Parameters:

statusStr : The sub-device status string to convert

Return: The corresponding status. UNKNOWN if unknown sub-device status

function functionStatusToString¶

public static String functionStatusToString(
    EFunctionStatus status
)

Convert EFunctionStatus enum to string.

Parameters:

status : The funciton status to convert

Return: The corresponding string value. "UNKNOWN" if unknown function status

function stringToFunctionStatus¶

public static EFunctionStatus stringToFunctionStatus(
    String statusStr
)

Convert string to EFunctionStatus.

Parameters:

statusStr : The function status string to convert

Return: The corresponding status. UNKNOWN if unknown function status

function connectionTypeDescToString¶

public static String connectionTypeDescToString(
    EConnectionTypeDesc connectionTypeDesc
)

Convert EConnectionTypeDesc enum to string.

Parameters:

connectionTypeDesc : The connection type to convert

Return: The corresponding string value. "" if unknown connection type

function stringToConnectionTypeDesc¶

public static EConnectionTypeDesc stringToConnectionTypeDesc(
    String connectionTypeDescStr
)

Convert string to EConnectionTypeDesc.

Parameters:

connectionTypeDescStr : The connection type string to convert

Return: The corresponding type. NONE if unknown connection type

function logLevelToString¶

public static String logLevelToString(
    ELogLevel logLevel
)

Convert ELogLevel enum to string.

Parameters:

logLevel : The log level to convert

Return: The corresponding string value

function stringToLogLevel¶

public static ELogLevel stringToLogLevel(
    String logLevelStr
)

Convert string to ELogLevel.

Parameters:

logLevelStr : The log level string to convert

Return: The corresponding log level

function dataToString¶

public static String dataToString(
    UCharVector data
)

Convert data bytes to string.

Parameters:

data : The vector of bytes to convert

Return: The resulting string

Converts a vector of bytes into a string representation.

function dataToInt¶

public static int dataToInt(
    UCharVector data
)

Convert data bytes to integer.

Parameters:

data : The vector of bytes to convert

Return: The resulting integer

Converts a vector of bytes into an integer value.

function dataToDouble¶

public static double dataToDouble(
    UCharVector data
)

Convert data bytes to double.

Parameters:

data : The vector of bytes to convert

Return: The resulting double

Converts a vector of bytes into a double value.

function boxTypeToString¶

public static String boxTypeToString(
    EBoxType type
)

Convert EBoxType enum to string.

Parameters:

type : The device controller type to convert

Return: The corresponding string value. "UNKNOWN" if unknown device controller type

function stringToBoxType¶

public static EBoxType stringToBoxType(
    String boxTypeStr
)

Convert string to EBoxType.

Parameters:

boxTypeStr : The device controller type string to convert

Return: The corresponding type. UNKNOWN if unknown device controller type

function stripAsTag¶

public static String stripAsTag(
    String str
)

Strip string to only keep alphanumeric characters for use as a tag.

Parameters:

str : The string to strip

Return: The resulting stripped string

Protected Functions Documentation¶

function Utils¶

protected Utils(
    long cPtr,
    boolean cMemoryOwn
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Utils obj
)

function swigRelease¶

protected static long swigRelease(
    Utils obj
)

Protected Attributes Documentation¶

variable swigCMemOwn¶

transient boolean swigCMemOwn;

Updated on 2026-06-23 at 10:35:25 +0200